JBoss.orgCommunity Documentation
There are multiple binary distributions of the Mobicents SIP Presence Service.
Description of the different Mobicents SIP Presence Service Distributions
These installation instructions detail the installation, running and configuring of the Integrated binary Mobicents SIP Presence Service distribution. This distribution includes the XDM and SIP Presence Servers, the servers are pre-installed in a version of the Mobicents JAIN SLEE, and the Mobicents JAIN SLEE SIP11 and HTTP Servlet Resource Adaptors. Examples of JAIN SLEE applications interacting with the Mobicents Integrated SIP Presence Service are also included and come pre-installed.
Users who wish to deploy the Mobicents XML Document Server on a different host or who do not require the Mobicents Presence Server should install the stand-alone Mobicents XDM Server binary distribution. The following installation, running and configuring instructions provide parallel instructions specific to the Mobicents XDM Server.
Users who have already installed and set up a separate Mobicents JAIN SLEE installation may want to install one or more servers of the Mobicents SIP Presence Service.
You should ensure that a few requirements have been met before continuing with the install.
Hardware Requirements
The Mobicents SIP Presence Service is an 100% Java application. Mobicents SIP Presence Service will run on the same hardware that the Mobicents JAIN SLEE runs on.
Software Prerequisites
A working installation of the Java Development Kit (JDK) version 6 or higher is required in order to run the Mobicents SIP Presence Service.
A working installation of the Apache Ant 1.6 or later is required in order to install the Mobicents SIP Presence Service release without Mobicents JAIN SLEE.
The Mobicents SIP Presence Service is a set of JAIN SLEE and JEE components built on top of Mobicents JAIN SLEE container.
The environment variable JBOSS_HOME, if set, must be pointing to the JBoss AS within Mobicents JAIN SLEE.
You can download the latest version of the Mobicents SIP Presence Service distribution you need from the Mobicents Downloads
page at https://sourceforge.net/projects/mobicents/files/Mobicents%20SIP%20Presence%20Service/. The latest releases are nearer the top.
If you are unsure which distribution zip file to download, refer to Description of the different Mobicents SIP Presence Service Distributions, and then to the following list of release binaries.
Mobicents SIP Presence Service Binary Distribution Zip Files
Download this zip file to obtain the Mobicents Integrated SIP Presence Service binary distribution, which includes the Mobicents SIP Presence Server, the Mobicents XDM Server, and the JBoss Application Server with Mobicents JAIN SLEE, well as all required JAIN SLEE Resource Adaptors.
Download this zip file to obtain the Mobicents XDM Server binary distribution, which bundles the JBoss Application Server with Mobicents JAIN SLEE.
The Mobicents Platform (Mobicents) is built on top of the JBoss Application Server (JBoss AS). You do not need to set the JBOSS_HOME
environment variable to run any of the Mobicents Platform servers unless JBOSS_HOME
is already set.
The best way to know for sure whether JBOSS_HOME
was set previously or not is to perform a simple check which may save you time and frustration.
At the command line, echo
$JBOSS_HOME
to see if it is currently defined in your environment:
~]$ echo $JBOSS_HOME
The Mobicents Platform and most Mobicents servers are built on top of the JBoss Application Server (JBoss AS). When the Mobicents Platform or Mobicents servers are built from source, then JBOSS_HOME
must be set, because the Mobicents files are installed into (or “over top of” if you prefer) a clean JBoss AS installation, and the build process assumes that the location pointed to by the JBOSS_HOME
environment variable at the time of building is the JBoss AS installation into which you want it to install the Mobicents files.
This guide does not detail building the Mobicents Platform or any Mobicents servers from source. It is nevertheless useful to understand the role played by JBoss AS and JBOSS_HOME
in the Mobicents ecosystem.
The immediately-following section considers whether you need to set JBOSS_HOME
at all and, if so, when. The subsequent sections detail how to set JBOSS_HOME
on Unix and Windows
Even if you fall into the category below of not needing to set JBOSS_HOME
, you may want to for various reasons anyway. Also, even if you are instructed that you do not need to set JBOSS_HOME
, it is good practice nonetheless to check and make sure that JBOSS_HOME
actually isn't set or defined on your system for some reason. This can save you both time and frustration.
JBOSS_HOME
if......you have installed the Mobicents Platform binary distribution.
...you have installed a Mobicents server binary distribution which bundles JBoss AS.
JBOSS_HOME
if......you are installing the Mobicents Platform or any of the Mobicents servers from source.
...you are installing the Mobicents Platform binary distribution, or one of the Mobicents server binary distributions, which do not bundle JBoss AS.
Naturally, if you installed the Mobicents Platform or one of the Mobicents server binary releases which do not bundle JBoss AS, yet requires it to run, then you should install JBoss AS
before setting JBOSS_HOME
or proceeding with anything else.
The JBOSS_HOME
environment variable must point to the directory which contains all of the files for the Mobicents Platform or individual Mobicents server that you installed. As another hint, this topmost directory contains a bin
subdirectory.
Setting JBOSS_HOME
in your personal ~/.bashrc
startup script carries the advantage of retaining effect over reboots. Each time you log in, the environment variable is sure to be set for you, as a user. On Unix, it is possible to set JBOSS_HOME
as a system-wide environment variable, by defining it in /etc/bashrc
, but this method is neither recommended nor detailed in these instructions.
Procedure 2.1. To Set JBOSS_HOME on Unix...
Open the ~/.bashrc
startup script, which is a hidden file in your home directory, in a text editor, and insert the following line on its own line while substituting for the actual install location on your system:
export JBOSS_HOME="/home/<username>/<path>/<to>/<install_directory>"
Save and close the .bashrc
startup script.
You should source
the .bashrc
script to force your change to take effect, so that JBOSS_HOME
becomes set for the current session[1].
~]$ source ~/.bashrc
Finally, ensure that JBOSS_HOME
is set in the current session, and actually points to the correct location:
The command line usage below is based upon a binary installation of the Mobicents Platform. In this sample output, JBOSS_HOME
has been set correctly to the topmost_directory
of the Mobicents installation. Note that if you are installing one of the standalone Mobicents servers (with JBoss AS bundled!), then JBOSS_HOME
would point to the topmost_directory
of your server installation.
~]$ echo $JBOSS_HOME /home/silas/<path>/<to>/<install_directory>
The JBOSS_HOME
environment variable must point to the directory which contains all of the files for the Mobicents Platform or individual Mobicents server that you installed. As another hint, this topmost directory contains a bin
subdirectory.
For information on how to set environment variables in recent versions of Windows, refer to http://support.microsoft.com/kb/931715.
Once the requirements and prerequisites have been met, and you have downloaded the correct zip file for the binary distribution you need, you are ready to install, please follow the instructions below.
Procedure 2.2. Installing a Mobicents SIP Presence Service Binary Distribution bundled with Mobicents JAIN SLEE
Unzip the release file
Ensure that the environment variable JBOSS_HOME is either not set, or pointing to the <install_directory>
directory extracted from the release file.
Procedure 2.3. Installing a Mobicents SIP Presence Service Binary Distribution without Mobicents JAIN SLEE
Unzip the release file
Ensure that the environment variable JBOSS_HOME is set and pointing to the JBoss AS with the Mobicents JAIN SLEE, where Mobicents SIP Presence Service components should be installed.
Invoke the correct Apache Ant target in build.xml script to install:
~]$ ant integrated-deploy
~]$ ant xdms-deploy
Once installed, you can run server(s) by executing the run.sh (Unix) or run.bat (Microsoft Windows) startup scripts in the <install_directory>/bin
directory (on Unix or Windows).
By default the server(s) start and bind to 127.0.0.1 IP, to use a different hostname or IP use the -b HOST parameter when executing the startup script (e.g. run.sh -b 172.31.1.1).
You can shut down the server(s) you can run server(s) by executing the shutdown.sh (Unix) or shutdown.bat (Microsoft Windows) scripts in the <install_directory>/bin
directory (on Unix or Windows). Note that if you properly stop the server, you will see the following three lines as the last output in the Unix terminal or Command Prompt:
[Server] Shutdown complete Shutdown complete Halting VM
Procedure 2.4. Uninstalling a Mobicents SIP Presence Service Binary Distribution bundled with Mobicents JAIN SLEE
To uninstall the SIP Presence Service or XDM Server, simply delete the directory you decompressed the binary distribution archive into.
The source building process requires access to the Internet. It also requires an SVN Client (to sources checkout) and Apache Maven2 2.0.9+ (for the building process) installed.
The source project can be downloaded using SVN, the checkout URL is http://mobicents.googlecode.com/svn/tags/servers/sip-presence/mobicents-sip-presence-service-1.0.0.CR1
Mobicents SIP Presence Service configurations can be done through the root pom.xml
.
To build the binaries from source, enter the release directory inside the directory used to checkout the source project and:
~]$ ant
[1]
Note that any other terminals which were opened prior to your having altered .bashrc
will need to source
~/.bashrc
as well should they require access to JBOSS_HOME
.